M

MLOG

فارسی

بیاموزید که چگونه منبع‌یابی رویداد می‌تواند پیاده‌سازی ردپای ممیزی شما را متحول کرده و قابلیت ردیابی بی‌نظیر، یکپارچگی داده و انعطاف‌پذیری سیستم را ارائه دهد. مثال‌های عملی و استراتژی‌های پیاده‌سازی را بررسی کنید.

منبع‌یابی رویداد (Event Sourcing): پیاده‌سازی ردپاهای ممیزی برای سیستم‌های قوی و قابل ردیابی

در چشم‌انداز دیجیتال پیچیده و به‌هم‌پیوسته امروزی، حفظ یک ردپای ممیزی قوی و جامع از اهمیت بالایی برخوردار است. این موضوع نه تنها اغلب یک الزام قانونی است، بلکه برای رفع اشکال، تحلیل امنیتی و درک تکامل سیستم شما نیز حیاتی است. منبع‌یابی رویداد (Event Sourcing)، یک الگوی معماری که تمام تغییرات حالت یک برنامه را به صورت دنباله‌ای از رویدادها ثبت می‌کند، راه‌حلی زیبا و قدرتمند برای پیاده‌سازی ردپاهای ممیزی قابل اعتماد، قابل بازرسی و قابل توسعه ارائه می‌دهد.

منبع‌یابی رویداد (Event Sourcing) چیست؟

برنامه‌های سنتی معمولاً فقط وضعیت فعلی داده‌ها را در یک پایگاه داده ذخیره می‌کنند. این رویکرد، بازسازی وضعیت‌های گذشته یا درک دنباله‌ای از رویدادهایی که به وضعیت فعلی منجر شده‌اند را دشوار می‌سازد. در مقابل، منبع‌یابی رویداد بر ثبت هر تغییر مهم در حالت برنامه به عنوان یک رویداد تغییرناپذیر تمرکز دارد. این رویدادها در یک ذخیره‌گاه رویداد فقط-افزودنی (append-only) ذخیره می‌شوند و یک رکورد کامل و زمانی از تمام اقدامات درون سیستم را تشکیل می‌ده دهند.

این را مانند دفتر حساب یک بانک در نظر بگیرید. به جای ثبت ساده موجودی فعلی، هر واریز، برداشت و انتقال به عنوان یک رویداد جداگانه ثبت می‌شود. با بازپخش این رویدادها، می‌توانید وضعیت حساب را در هر نقطه از زمان بازسازی کنید.

چرا از منبع‌یابی رویداد برای ردپاهای ممیزی استفاده کنیم؟

منبع‌یابی رویداد چندین مزیت قانع‌کننده برای پیاده‌سازی ردپاهای ممیزی ارائه می‌دهد:

پیاده‌سازی منبع‌یابی رویداد برای ردپاهای ممیزی: راهنمای گام به گام

در اینجا یک راهنمای عملی برای پیاده‌سازی منبع‌یابی رویداد برای ردپاهای ممیزی آورده شده است:

۱. شناسایی رویدادهای کلیدی

اولین قدم، شناسایی رویدادهای کلیدی است که می‌خواهید در ردپای ممیزی خود ثبت کنید. این رویدادها باید نشان‌دهنده تغییرات مهم در وضعیت برنامه باشند. اقداماتی مانند موارد زیر را در نظر بگیرید:

مثال: برای یک پلتفرم تجارت الکترونیک، رویدادهای کلیدی ممکن است شامل «OrderCreated» (سفارش ایجاد شد)، «PaymentReceived» (پرداخت دریافت شد)، «OrderShipped» (سفارش ارسال شد)، «ProductAddedToCart» (محصول به سبد خرید اضافه شد) و «UserProfileUpdated» (پروفایل کاربر به‌روز شد) باشد.

۲. تعریف ساختار رویداد

هر رویداد باید ساختار کاملاً مشخصی داشته باشد که شامل اطلاعات زیر باشد:

مثال: رویداد «OrderCreated» ممکن است ساختار زیر را داشته باشد:

{
  "eventType": "OrderCreated",
  "eventData": {
    "orderId": "12345",
    "customerId": "67890",
    "orderDate": "2023-10-27T10:00:00Z",
    "totalAmount": 100.00,
    "currency": "USD",
    "shippingAddress": {
      "street": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zipCode": "91234",
      "country": "USA"
    }
  },
  "timestamp": "2023-10-27T10:00:00Z",
  "userId": "user123",
  "transactionId": "tx12345",
  "correlationId": "corr123",
  "metadata": {
    "ipAddress": "192.168.1.1",
    "browser": "Chrome",
    "location": {
       "latitude": 34.0522,
       "longitude": -118.2437
    }
  }
}

۳. انتخاب یک ذخیره‌گاه رویداد (Event Store)

ذخیره‌گاه رویداد، مخزن مرکزی برای ذخیره رویدادها است. این باید یک پایگاه داده فقط-افزودنی باشد که برای نوشتن و خواندن دنباله‌ای از رویدادها بهینه شده باشد. گزینه‌های مختلفی در دسترس هستند:

هنگام انتخاب یک ذخیره‌گاه رویداد، عواملی مانند موارد زیر را در نظر بگیرید:

۴. پیاده‌سازی انتشار رویداد

هنگامی که یک رویداد رخ می‌دهد، برنامه شما باید آن را به ذخیره‌گاه رویداد منتشر کند. این معمولاً شامل مراحل زیر است:

مثال (با استفاده از یک EventStoreService فرضی):

public class OrderService {

  private final EventStoreService eventStoreService;

  public OrderService(EventStoreService eventStoreService) {
    this.eventStoreService = eventStoreService;
  }

  public void createOrder(Order order, String userId) {
    // ... business logic to create the order ...

    OrderCreatedEvent event = new OrderCreatedEvent(
        order.getOrderId(),
        order.getCustomerId(),
        order.getOrderDate(),
        order.getTotalAmount(),
        order.getCurrency(),
        order.getShippingAddress()
    );

    eventStoreService.appendEvent("order", order.getOrderId(), event, userId);
  }
}

public class EventStoreService {

  public void appendEvent(String streamName, String entityId, Object event, String userId) {
    // Create an event object
    EventRecord eventRecord = new EventRecord(
        UUID.randomUUID(), // eventId
        streamName,  // streamName
        entityId,   // entityId
        event.getClass().getName(), // eventType
        toJson(event),  // eventData
        Instant.now().toString(), // timestamp
        userId  // userId
    );

    // Serialize the event
    String serializedEvent = toJson(eventRecord);

    // Append the event to the event store (implementation specific to the chosen event store)
    storeEventInDatabase(serializedEvent);

    // Publish the event to subscribers (optional)
    publishEventToMessageQueue(serializedEvent);
  }

  // Placeholder methods for database and message queue interaction
  private void storeEventInDatabase(String serializedEvent) {
    // Implementation to store the event in the database
    System.out.println("Storing event in database: " + serializedEvent);
  }

  private void publishEventToMessageQueue(String serializedEvent) {
    // Implementation to publish the event to a message queue
    System.out.println("Publishing event to message queue: " + serializedEvent);
  }

  private String toJson(Object obj) {
    // Implementation to serialize the event to JSON
    try {
      ObjectMapper mapper = new ObjectMapper();
      return mapper.writeValueAsString(obj);
    } catch (Exception e) {
      throw new RuntimeException("Error serializing event to JSON", e);
    }
  }
}


class EventRecord {
  private final UUID eventId;
  private final String streamName;
  private final String entityId;
  private final String eventType;
  private final String eventData;
  private final String timestamp;
  private final String userId;

  public EventRecord(UUID eventId, String streamName, String entityId, String eventType, String eventData, String timestamp, String userId) {
    this.eventId = eventId;
    this.streamName = streamName;
    this.entityId = entityId;
    this.eventType = eventType;
    this.eventData = eventData;
    this.timestamp = timestamp;
    this.userId = userId;
  }

  // Getters

  @Override
  public String toString() {
    return "EventRecord{" +
        "eventId=" + eventId +
        ", streamName='" + streamName + '\'' +
        ", entityId='" + entityId + '\'' +
        ", eventType='" + eventType + '\'' +
        ", eventData='" + eventData + '\'' +
        ", timestamp='" + timestamp + '\'' +
        ", userId='" + userId + '\'' +
        '}';
  }
}

class OrderCreatedEvent {
    private final String orderId;
    private final String customerId;
    private final String orderDate;
    private final double totalAmount;
    private final String currency;
    private final String shippingAddress;

    public OrderCreatedEvent(String orderId, String customerId, String orderDate, double totalAmount, String currency, String shippingAddress) {
        this.orderId = orderId;
        this.customerId = customerId;
        this.orderDate = orderDate;
        this.totalAmount = totalAmount;
        this.currency = currency;
        this.shippingAddress = shippingAddress;
    }

    // Getters for all fields

    public String getOrderId() { return orderId; }
    public String getCustomerId() { return customerId; }
    public String getOrderDate() { return orderDate; }
    public double getTotalAmount() { return totalAmount; }
    public String getCurrency() { return currency; }
    public String getShippingAddress() { return shippingAddress; }

    @Override
    public String toString() {
        return "OrderCreatedEvent{" +
                "orderId='" + orderId + '\'' +
                ", customerId='" + customerId + '\'' +
                ", orderDate='" + orderDate + '\'' +
                ", totalAmount=" + totalAmount +
                ", currency='" + currency + '\'' +
                ", shippingAddress='" + shippingAddress + '\'' +
                '}';
    }
}

class Order {
  private final String orderId;
  private final String customerId;
  private final String orderDate;
  private final double totalAmount;
  private final String currency;
  private final String shippingAddress;

  public Order(String orderId, String customerId, String orderDate, double totalAmount, String currency, String shippingAddress) {
        this.orderId = orderId;
        this.customerId = customerId;
        this.orderDate = orderDate;
        this.totalAmount = totalAmount;
        this.currency = currency;
        this.shippingAddress = shippingAddress;
    }

    // Getters for all fields

    public String getOrderId() { return orderId; }
    public String getCustomerId() { return customerId; }
    public String getOrderDate() { return orderDate; }
    public double getTotalAmount() { return totalAmount; }
    public String getCurrency() { return currency; }
    public String getShippingAddress() { return shippingAddress; }

    @Override
    public String toString() {
        return "Order{" +
                "orderId='" + orderId + '\'' +
                ", customerId='" + customerId + '\'' +
                ", orderDate='" + orderDate + '\'' +
                ", totalAmount=" + totalAmount +
                ", currency='" + currency + '\'' +
                ", shippingAddress='" + shippingAddress + '\'' +
                '}';
    }
}

۵. ساخت مدل‌های خواندنی (Projections)

در حالی که ذخیره‌گاه رویداد یک تاریخچه کامل از تمام تغییرات را فراهم می‌کند، اغلب برای عملیات خواندن، پرس‌وجو مستقیم از آن کارآمد نیست. به جای آن، می‌توانید مدل‌های خواندنی (Read Models)، که به عنوان تصویر (projections) نیز شناخته می‌شوند، بسازید که برای الگوهای پرس‌وجوی خاص بهینه شده‌اند. این مدل‌های خواندنی از جریان رویداد مشتق شده و با انتشار رویدادهای جدید به صورت ناهمزمان به‌روز می‌شوند.

مثال: شما ممکن است یک مدل خواندنی ایجاد کنید که لیستی از تمام سفارشات برای یک مشتری خاص را در بر دارد، یا یک مدل خواندنی که داده‌های فروش یک محصول خاص را خلاصه می‌کند.

برای ساخت یک مدل خواندنی، شما در جریان رویداد مشترک می‌شوید و هر رویداد را پردازش می‌کنید. برای هر رویداد، مدل خواندنی را مطابق با آن به‌روز می‌کنید.

مثال:

public class OrderSummaryReadModelUpdater {

    private final OrderSummaryRepository orderSummaryRepository;

    public OrderSummaryReadModelUpdater(OrderSummaryRepository orderSummaryRepository) {
        this.orderSummaryRepository = orderSummaryRepository;
    }

    public void handle(OrderCreatedEvent event) {
        OrderSummary orderSummary = new OrderSummary(
                event.getOrderId(),
                event.getCustomerId(),
                event.getOrderDate(),
                event.getTotalAmount(),
                event.getCurrency()
        );

        orderSummaryRepository.save(orderSummary);
    }

    // Other event handlers for PaymentReceivedEvent, OrderShippedEvent, etc.
}

interface OrderSummaryRepository {
    void save(OrderSummary orderSummary);
}

class OrderSummary {
    private final String orderId;
    private final String customerId;
    private final String orderDate;
    private final double totalAmount;
    private final String currency;

    public OrderSummary(String orderId, String customerId, String orderDate, double totalAmount, String currency) {
        this.orderId = orderId;
        this.customerId = customerId;
        this.orderDate = orderDate;
        this.totalAmount = totalAmount;
        this.currency = currency;
    }
    //Getters
}

۶. امن‌سازی ذخیره‌گاه رویداد

ذخیره‌گاه رویداد حاوی داده‌های حساس است، بنابراین امن‌سازی صحیح آن بسیار حیاتی است. اقدامات امنیتی زیر را در نظر بگیرید:

۷. پیاده‌سازی ممیزی و گزارش‌گیری

پس از پیاده‌سازی منبع‌یابی رویداد، می‌توانید از جریان رویداد برای تولید گزارش‌های ممیزی و انجام تحلیل‌های امنیتی استفاده کنید. شما می‌توانید از ذخیره‌گاه رویداد برای یافتن تمام رویدادهای مربوط به یک کاربر، تراکنش یا موجودیت خاص پرس‌وجو کنید. همچنین می‌توانید از جریان رویداد برای بازسازی وضعیت سیستم در هر نقطه از زمان استفاده کنید.

مثال: شما ممکن است گزارشی تهیه کنید که تمام تغییرات ایجاد شده در یک پروفایل کاربری خاص را در یک دوره زمانی نشان دهد، یا گزارشی که تمام تراکنش‌های آغاز شده توسط یک کاربر خاص را نشان دهد.

قابلیت‌های گزارش‌گیری زیر را در نظر بگیرید:

چالش‌های منبع‌یابی رویداد

در حالی که منبع‌یابی رویداد مزایای زیادی را ارائه می‌دهد، چالش‌هایی را نیز به همراه دارد:

بهترین شیوه‌ها برای منبع‌یابی رویداد

برای کاهش چالش‌های منبع‌یابی رویداد، این بهترین شیوه‌ها را دنبال کنید:

مثال‌های واقعی از منبع‌یابی رویداد

منبع‌یابی رویداد در صنایع و برنامه‌های مختلفی استفاده می‌شود، از جمله:

نتیجه‌گیری

منبع‌یابی رویداد یک الگوی معماری قدرتمند است که می‌تواند پیاده‌سازی ردپای ممیزی شما را متحول کند. این الگو قابلیت ردیابی بی‌نظیر، یکپارچگی داده و انعطاف‌پذیری سیستم را فراهم می‌کند. در حالی که چالش‌هایی را به همراه دارد، مزایای منبع‌یابی رویداد اغلب بر هزینه‌ها غلبه می‌کند، به ویژه برای سیستم‌های پیچیده و حیاتی. با پیروی از بهترین شیوه‌های ذکر شده در این راهنما، می‌توانید با موفقیت منبع‌یابی رویداد را پیاده‌سازی کرده و سیستم‌های قوی و قابل ممیزی بسازید.

برای مطالعه بیشتر